Use fssnip highlighter in API docs code examples. #780
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
@yazeedobaid are you happy with this version? |
|
Now with the extra trailing blank line after the last line of code removed (adding back a prior dsyme fix). Should be ready for release.
|
|
@nhirschey tested the branch with the FAKE website and all is good. But I may add back that padding by a CSS rule for the code examples since it is more visually looking good with some padding: That is FAKE related. Thanks for the update. |
|
@nhirschey Fantastic work, thank you! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This adds syntax highlighting to API docs code examples. PR #762 from @yazeedobaid was solving the same problem, but it relied on external tools such as highlight.js to do the highlighting and required users to add that dependency. This PR uses FSharp.Formatting's baked-in highlighter to achieve the same goal.
For example, building the F# core docs Array.averageBy example using this PR:
In comparison, this is how it looks now: